home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / comm2 / mmtwtf12.lha / MM / Docs / MM_TwitFilter.Doc < prev   
Text File  |  1996-04-29  |  8KB  |  277 lines
  1.  
  2.  
  3.  
  4.                                   L   L  L   L
  5.                                   LL LL  LL LL
  6.                                   L L L  L L L
  7.                                   L   L  L   L
  8.                                   L   L  L   L
  9.  
  10.  
  11.         LLLLL  L   L  LLL  LLLLL  LLLLL  LLL  L     LLLLL  LLLLL  LLLL
  12.           L    L   L   L     L    L       L   L       L    L      L   L
  13.           L    L L L   L     L    LLLL    L   L       L    LLLL   LLLL
  14.           L    LL LL   L     L    L       L   L       L    L      L  L
  15.           L    L   L  LLL    L    L      LLL  LLLL    L    LLLLL  L   L
  16.  
  17.  
  18.                              L   L  LL      L  LL
  19.                              L   L L  L    LL L  L
  20.                              L   L L  L   L L   L
  21.                               L L  L  L     L  L
  22.                                L    LL  L   L LLLL
  23.  
  24.  
  25.  
  26.  
  27.                            (C)  1996  Robert Hofmann
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  1. Introduction
  34.  ===============
  35.  
  36.   1.1 Legal stuff
  37.   ---------------
  38.  
  39.    MM_TwitFilter is, as the name already says, a twit-filter for Mail Manager by
  40.    Pino Aliberti.
  41.  
  42.    The programs and files in this distribution are freely distributable, but are
  43.    also Copyright (c) Robert Hofmann.  They may be freely distributed as long as
  44.    no more than a nominal fee is charged to cover time and copying costs.
  45.  
  46.    No commercial usage is  permitted without  written permission from the author
  47.    Everything in this distribution must be kept together, in original unmodified
  48.    form.
  49.  
  50.  
  51.    MM_TwitFilter is mailware :-). This  means if  you use it,  please write me a
  52.    short mail. You know,  it is frustrating  to write programs  and there are no
  53.    responses from the users if they like it or not...
  54.  
  55.  
  56.    Accepting these few points is the only condition for using MM_TwitFilter...
  57.  
  58.  
  59.  
  60.    =============================================================================
  61.    The author is not responsible for any  problems caused by using this program!
  62.    =============================================================================
  63.  
  64.  
  65.  
  66.   1.2 General stuff
  67.   -----------------
  68.  
  69.    I am not the best in  writing doc, but quiet good  in coding I think :-) This
  70.    docs are a bit  short I have to  appolognize, but I hope you'll understand it
  71.    anyway... Especially my English and the typo's ;-)
  72.  
  73.  
  74.    If there is  anybody out there  who is able to &  wants translate the docs to
  75.    his own language, please do so and send them to me! I'll add them to the next
  76.    release. Also translators always will get the newest betas! ;-)
  77.  
  78.    Unfortunatly I don't have the will & time to translate my docs even to German
  79.    - my time is better used for coding :-)
  80.  
  81.  
  82.  
  83.  
  84.  
  85.   1.3 Author
  86.   ----------
  87.  
  88.    If  you  have  suggestions  or remarks about this program, or if you find any
  89.    bugs, please let me know.
  90.  
  91.  
  92.    Contacting the author:
  93.  
  94.      Internet .. :  robert@next.amistep.osn.de (soon!)
  95.      FidoNet ... :  2:2490/1015.0   (may change soon!)
  96.      AmigaNet .. :  39:171/101.0
  97.  
  98.      Snail-mail  :  Robert Hofmann
  99.                     Volkmannstr. 35
  100.                     D-90443 Nürnberg
  101.                     Tel. +49-(0)-911-9941680 (18-20h German time only!!!)
  102.                     Germany
  103.  
  104.      Bank-Account:  Account-holder:  Robert Hofmann
  105.                     Account-number:  67920
  106.                     Bank-ID ..... :  76090000
  107.                     S.W.I.F.T.code:  GENO DE MV 760
  108.                     Bank-name ... :  Volksbank Nuernberg e.G.
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  2. Features
  115.  ===========
  116.  
  117.   MM_TwitFilter...
  118.  
  119.      ... is configurable per area & global
  120.      ... is able to check single, multiple or all areas
  121.      ... has a full AmigaDos-wildcard-support
  122.      ... is able to search over all msg-fields (single or combined!)
  123.      ... can use the DEL-flag or physically deletes the msg
  124.      ... has an advanced cfg-read-meachanism
  125.      ... does only process #ECHOAREAs, excluding own msgs
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  3. Installation
  132.  ===============
  133.  
  134.   1. Copy the files to the related MM:-directories.
  135.  
  136.   2. Adjust the cfg to your own needs.
  137.  
  138.   3. Add it as last entry to your import-batch or whatever else you use.
  139.  
  140.   4. Add the following line to your MM.cfg:
  141.  
  142.       #BROWSEMENU "Filter this area" "rx MM:Rexx/MM_TwitFilter %a" ""
  143.  
  144.  
  145.   IMPORTANT: MM_TwitFilter.rexx  *MUST*  be  placed  in  "MM:Rexx/"!!!  This  is
  146.              necessary  because  MM_TwitFilter  appends  its  cfg  to the script
  147.              itself for a *VERY* fast cfg-reading.
  148.                               *** NEVER TOUCH ITS FILENOTE!!! ***
  149.  
  150.  
  151.   As you may have seen, there's a second  script called "MM_TwitFilter.rexx.cmp"
  152.   included. This  is a exacltly the same script  as "MM_TwitFilter.rexx" itself,
  153.   except that it was compressed with "CompressRexx v2.1".
  154.  
  155.   On slow machines, it  might be useful to  replace the uncompressed script with
  156.   the  compressed one because it is slightly faster... But  please test it first
  157.   with the uncompressed  version, because if an error occurs,  finding the error
  158.   due to error-reports of the compressed script is nearly impossible!
  159.  
  160.   If you really want to use  the compressed script, you  have to REPLACE the un-
  161.   compressed script with the compressed  one! The used script MUST exactly named
  162.   "MM:Rexx/MM_TwitFilter.rexx", otherwise it will not work!
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  4. Usage
  169.  ========
  170.  
  171.   [RX] MM_TwitFilter[.rexx] AREA,SETDEL/S
  172.  
  173.     AREA     Areatag. If not present, all configured areas will be filtered.
  174.  
  175.     SETDEL   Instead of directly deleting the msg, it will be flagged as 'DEL'.
  176.              This is much slower than simply deleting the msg!
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  5. Configuration
  183.  ================
  184.  
  185.  
  186.   5.1 #AREA <areatag>
  187.   -------------------
  188.  
  189.    The areatag of the area.
  190.  
  191.  
  192.    Kill       <from-pattern> <to-pattern> <subj-pattern>
  193.  
  194.    KillFrom   <pattern>
  195.  
  196.    KillTo     <pattern>
  197.  
  198.    KillSubj   <pattern>
  199.  
  200.  
  201.    The pattern  must be a  valid AmigaDos-wildcard (see  e.g. the  example-cfg).
  202.    Multiple  statments are possible,  but slower that if  you use advanced wild-
  203.    cards, e.g.
  204.  
  205.     KillFrom  "Joe User"
  206.     KillFrom  "Henry Twit"
  207.  
  208.    is the same like
  209.  
  210.     KillFrom  "*(Joe User|Henry Twit)*"
  211.  
  212.    but the second example is much faster!
  213.  
  214.  
  215.  
  216.   5.2 #ALL
  217.   --------
  218.  
  219.    This is the global entry. You must not set an areatag here, of course :-)
  220.  
  221.    The usage of Kill*-keywords is the same as in 5.1.
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  6. Theory of operation
  228.  ======================
  229.  
  230.   MM_TwitFilter normally  should be started directly  after your import, so that
  231.   all twits can be filtered out immediately.
  232.  
  233.   It will only be searched for SENT msgs not written by you yourself.
  234.  
  235.   For every Kill-statement it will be started one search. So the more statements
  236.   you use the slower it will be.
  237.  
  238.   If you want to try it out, just use  SETDEL/S, so the msgs will not be deleted
  239.   immediately, but only flagged as DEL, so you can clear this flag if you made a
  240.   mistake.
  241.  
  242.  
  243.   IMPORTANT NOTE: It would be an excessivly annoying behaviour if you modify the
  244.                   script and use it on TwoPassImport-areas to filter people you
  245.                   don't like!!!
  246.  
  247.  
  248.   PS: I've not fully tested it, so there might be some bugs left.
  249.       Please report them to me!
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  7. Acknowledgements
  256.  ===================
  257.  
  258.   Pino Aliberti     For his EXCELLENT Mail Manager! For  implementing nearly all
  259.                     I wanted (this was much work I think and delayed the release
  260.                     of MM for  some month ;-)) For our  hard but fair  fights in
  261.                     MMBETA and at least  for the nice note  about me in the docs
  262.                     8^))))
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.   _  o         Robert Hofmann         2:2490/1015@FidoNet   37:108/220@TrekNet
  274.  |<)_/#                              39:171/101@AmigaNet   107:1805/230@TrekNet
  275.  TT  <T  robert@next.amistep.osn.de  56:63/201@XNet        213:314/9127@XCessNet
  276.  
  277.